Skip to content

Auto-generate VISCfunctions website with pkgdown/GH actions#119

Merged
slager merged 6 commits intodevelopfrom
pkgdown
Dec 3, 2025
Merged

Auto-generate VISCfunctions website with pkgdown/GH actions#119
slager merged 6 commits intodevelopfrom
pkgdown

Conversation

@slager
Copy link
Contributor

@slager slager commented Sep 18, 2025

Attempt to set up automated github pages website via usethis defaults.

Renders successfully on a local site build with pkgdown::build_site()

Needs to make its way into main to be deployed onto the github.io website.

@slager slager changed the title use_pkgdown_github_pages() Auto-generate VISCfunctions website with pkgdown/GH actions Sep 18, 2025
@kelliemac
Copy link
Contributor

Renders successfully locally with pkgdown::build_site() for me too! Looks great, thanks so much for setting this up, @slager !

A couple of things I immediately notice in looking at the site that we may want to fix sooner rather than later:

  1. List of developers is out-of date - consider adding Dave and I to the list, and updating the package maintainer (currently Jimmy, who is not at VISC anymore)
  2. The "Title" field in the DESCRIPTION file is currently "VISC STP/SRA functions" and this is what I see as the tab name when I have the site open. I would prefer to just see "VISCfunctions" or something along those lines

@slager or @mayerbry any thoughts about these two items? My inclination is to make those changes in this PR (assuming you agree they're a good idea in general), since they're small and easy to knock out now. (But save any changes to documentation of individual functions, etc. for later.)

@kelliemac
Copy link
Contributor

actually I've only done one PR to VISCfunctions so I'm not sure I need to be listed as a developer (sometimes I mix up what's happened here vs. in VISCtemplates)... but I maintain my opinion that we should add Dave :)

@kelliemac
Copy link
Contributor

@mayerbry can you review this PR and let us know what you think?

@slager
Copy link
Contributor Author

slager commented Dec 2, 2025

Thinking about @kelliemac 's suggestions a little bit

  1. I think we can probably add an issue to decide on authors prior to the next release. This PR just puts in the machinery to auto-build the website from the current DESCRIPTION
  2. The browser tab name includes both the "title" (which follows best practices in length and content for the 'title' field) and the package name, which seems okay to me. My inclination is not to customize.

Copy link
Contributor

@mayerbry mayerbry left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great!!

Per our discussion:

  • it would be nice if the browser tab started with the package name (package name:title, instead of title:package name) but that maybe that's not trivial
  • Update author list
    • remove email from former hutch folks
    • move current authors to top (me, Dave, Kellie, Gabby, Claudio)
    • Ideal: make an "Original Authors" list and move former authors there
    • simple (if ideal is a pain): just move original authors to the end of the current list

@kelliemac
Copy link
Contributor

@slager just to be clear I am perfectly happy with you merging this PR with or without incorporating any of the suggestions from me! if it's not straightforward to tackle them now, don't worry about it. it sounds like you and bryan chatted about this too but I don't think this PR needs to be held up on my account.

@slager slager merged commit 12a2d0d into develop Dec 3, 2025
6 checks passed
@slager slager deleted the pkgdown branch December 3, 2025 01:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants